Interface Cable

All Superinterfaces:
IPCObject, Link
All Known Implementing Classes:
CableImpl

public interface Cable extends Link
Information provided by the PKI file:

    \class Cable
    
    \brief Cable is the generic cable class with two endpoints.
    
    \example network().getDevice("Router0").getPort("FastEthernet0/0").getLink()
    
Author:
Auto-generated
  • Method Details

    • getPort1

      Port getPort1()
      Information provided by the PKI file:
      
          \brief Returns the port on the first end of the cable.
          
          \return Port, the port on the first end of the cable.
          
              
      Returns:
      Port Returns a Port
    • getPort2

      Port getPort2()
      Information provided by the PKI file:
      
          \brief Returns the port on the second end of the cable.
          
          \return Port, the port on the second end of the cable.
          
              
      Returns:
      Port Returns a Port
    • getOtherPort

      Port getOtherPort(String deviceName, String portName)
      Information provided by the PKI file:
      
          \brief Returns the other port based on the specified port on one side of the cable.
          
          \param deviceName, name of the device (not the IOS name)
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
          \return Port, value is the other port based on the specified port on one side of the cable.
          
              
      Parameters:
      deviceName - Takes in a parameter of deviceName
      portName - Takes in a parameter of portName
      Returns:
      Port Returns a Port